FlowDocumentState

Manages the state of flow documents within the workflow.

The FlowDocumentState class is responsible for managing and updating the states of documents within a workflow. It inherits from FlowObjectDesigner and provides functionality to update document states either individually or in batch. The class includes properties for managing assigner positions and document collections, along with methods for state updates and logging.

Key features:

• Manages document state updates in a workflow
• Supports batch updates for multiple documents
• Provides logging for state update operations
• Handles document validation before updates
• Implements workflow designer functionality

Properties

Name	Description
Key	A unique identifier for the workflow step.
WorkflowCodeInstance	The workflow code instance associated with the flow object.
CachedDMObjects	The cached document management objects related to the flow object.
TypeCode	The type code associated with the flow object.
Name	Name for the workflow step.
Documents	Gets or sets the list of documents to be updated.
AssignerPositionObjectName	Gets or sets the name of the assigner position object.
Caption	The caption dictionary representing localized captions for the flow object.

Constructors

Name	Description
FlowDocumentState(name, workflowData, workflowCodeInstance)	Initializes a new instance of the FlowDocumentState class.
FlowDocumentState(name, workflowData, workflowCodeInstance)	Constructor for the FlowDocumentState class. Initializes a new instance of the FlowDocumentState class.

Methods

Name	Description
Initialize()	Sets up initial configurations for the flow document state.
UpdateStates()	Asynchronously updates the states of all documents within the flow.
UpdateState(flowDocument, state)	Asynchronously updates the state of a single flow document.

Events

Name	Description
OnBeforeExecution(sender, args)	Occurs before the execution of the workflow step.
OnAfterExecution(sender, args)	Occurs after the execution of the workflow step.

Generic Types

Name	Description
TProperties	Generic type of properties.